/*
    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.
 */
package erwiki.api.plugin;

import java.util.Map;

import erwiki.api.core.WikiContext;
import erwiki.api.exceptions.PluginException;

/**
 * Определяет интерфейс для плагинов. Любой экземпляр вики-плагина должен реализовывать этот
 * интерфейс.
 */
public interface WikiPlugin {

	/** Имя пакета ресурсов плагина по умолчанию. */
	String CORE_PLUGINS_RESOURCEBUNDLE = "plugin.PluginResources";

	/**
	 * Это основная точка входа для любого плагина. Производится парсинг параметров, и специальный
	 * параметр под названием "_body" обозначает имя тела плагина, т.е. ту часть плагина, которая не
	 * является параметром вида "key=value". Эта область отделяется пустой строкой или символом ':'.
	 * <p>
	 * Обратите внимание: желательно, чтобы плагин возвращал XHTML-совместимый HTML (т.е. закрывал все
	 * теги, использовал &lt;br /&gt; вместо &lt;br&gt; и т.д.
	 *
	 * @param context Текущий WikiContext.
	 * @param params  Map, содержащая пары ключ-значение. Любой параметр, указанный пользователем
	 *                страница вики будет содержать параметры String-String, но возможно, что при
	 *                когда-нибудь в будущем, эта Wiki предоставит вам другие вещи, которые не являются
	 *                Strings.
	 * @return HTML, готовый для включения в отображаемую страницу.
	 * @throws PluginException в случае, если что-то пойдет не так.
	 */
	String execute(WikiContext context, Map<String, String> params) throws PluginException;

}
